home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Information / Digests / CSMP Digest / volume 1 / csmp-v1-206.txt < prev    next >
Encoding:
Text File  |  1994-12-08  |  33.1 KB  |  1,068 lines  |  [TEXT/R*ch]
  1. C.S.M.P. Digest             Tue, 03 Nov 92       Volume 1 : Issue 206
  2.  
  3. Today's Topics:
  4.  
  5.     Prefs file source code
  6.  
  7.  
  8.  
  9. The Comp.Sys.Mac.Programmer Digest is moderated by Michael A. Kelly.
  10.  
  11. The digest is a collection of article threads from the internet newsgroup
  12. comp.sys.mac.programmer.  It is designed for people who read c.s.m.p. semi-
  13. regularly and want an archive of the discussions.  If you don't know what a
  14. newsgroup is, you probably don't have access to it.  Ask your systems
  15. administrator(s) for details.  (This means you can't post questions to the
  16. digest.)
  17.  
  18. Each issue of the digest contains one or more sets of articles (called
  19. threads), with each set corresponding to a 'discussion' of a particular
  20. subject.  The articles are not edited; all articles included in this digest
  21. are in their original posted form (as received by our news server at
  22. cs.uoregon.edu).  Article threads are not added to the digest until the last
  23. article added to the thread is at least one month old (this is to ensure that
  24. the thread is dead before adding it to the digest).  Article threads that
  25. consist of only one message are generally not included in the digest.
  26.  
  27. The entire digest is available for anonymous ftp from ftp.cs.uoregon.edu
  28. [128.223.8.8] in the directory /pub/mac/csmp-digest.  Be sure to read the
  29. file /pub/mac/csmp-digest/README before downloading any files.  The most
  30. recent issues are available from sumex-aim.stanford.edu [36.44.0.6] in the
  31. directory /info-mac/digest/csmp.  If you don't have ftp capability, the sumex
  32. archive has a mail server; send a message with the text '$MACarch help' (no
  33. quotes) to LISTSERV@ricevm1.rice.edu for more information.
  34.  
  35. The digest is also available via email.  Just send a note saying that you
  36. want to be on the digest mailing list to mkelly@cs.uoregon.edu, and you will
  37. automatically receive each new issue as it is created.  Sorry, back issues
  38. are not available through the mailing list.
  39.  
  40. Send administrative mail to mkelly@cs.uoregon.edu.
  41.  
  42.  
  43. -------------------------------------------------------
  44.  
  45. From: Sproul@sproul.sproul.com (Mark Sproul)
  46. Subject: Prefs file source code
  47. Date: 29 Sep 92 08:05:41 GMT
  48. Organization: Sproul Consulting
  49.  
  50. Several people asked for this source code.  As explained in the comments,
  51. it came from Inside Mac Comm Toolbox and there is a lot of code dealing
  52. just with the Comm Tool box setup.  It now handles the PREFERENCES
  53. folder in the system folder properly.
  54.  
  55. I have done some additions to the code to make it more general and
  56. usable as far as dealing with preferences.  Such as GET pref and SET
  57. pref.  This code was all written and runs correctly with Think C 5.0.
  58.  
  59. Its been several months since I wrote this and was looking at it.
  60. I may have forgotten to mention something, if you have any problems
  61. let me know and I will post updates.
  62.  
  63. You need to define some things such as this:
  64.  
  65. #define    creatorType        'abcd'
  66. #define    fileType        'PREF'
  67. #define    prefsFileName    "\pMyPreferences"
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74. /******************************************************************************
  75. * adapted from
  76. *  Inside the Macintosh Communications Toolbox
  77. * Page  333
  78. * After initialization, the code shown first checks if a
  79. * preferences folder, which contains tool settings written in preference
  80. * files, already exists. If so, the application uses the settings in this file.
  81. * Otherwise, the code generates a new preferences file.
  82. ******************************************************************************
  83. * Modifications
  84. ******************************************************************************
  85. * Nov 27, 1991    Original version had a bug in it.
  86. *                If the "Preferences" directory already existed, the preferences file
  87. *                was placed in the system folder, not in the "Preferences" directory.
  88. *                If the directory did NOT exist, everything worked fine.
  89. *                I also changed it to check for the existance of the "Preferences" folder
  90. *                first instead of trying to create one and letting an duplicate file error
  91. *                indicate that it already existed.
  92. *                by Mark Sproul
  93. *                Internet: sproul@sproul.com
  94. *                AppleLink: Sproul.M
  95. * Jan 16, 1992    Working on a general purpose prefs file manipulator
  96. * Jan 25, 1992    Prefs file resources working great
  97. ******************************************************************************/
  98.  
  99. #include    <Connections.h>
  100. #include    <CommResources.h>
  101.  
  102. /*
  103. ** Global Variables used by all of the prefs routines
  104. */
  105. long            prefDirID;            /* Prefs Dir ID number */
  106. long            sysfDirID;            /* System folder Dir ID number */
  107. short            prefVRefNum;        /* Prefs Volume Ref number */
  108. short            prefFileOKFlag = 0;    /* prefs file OK indicator */
  109.  
  110. /*************************************************************
  111. * This makes sure there is a prefs file in the PREFERENCES directory
  112. * if not, it creates it.
  113. *
  114. * getPrefsFile MUST be called before any atempt at getting the prefs values
  115. *
  116. *************************************************************/
  117.  
  118. void getPrefsFile(prefsFileName, creatorType, fileType)
  119. Str255        prefsFileName;
  120. OSType        creatorType;
  121. OSType        fileType;
  122. {
  123. OSErr            osErr        = noErr;
  124. SysEnvRec        theWorld;
  125. CInfoPBPtr        infoPB;
  126. WDPBPtr            wdPB;
  127. HParmBlkPtr        dirPB;
  128.  
  129. short            prefRefNum;
  130. Point            where    = { 75, 75 };
  131. Str63            toolName;
  132. short            procID;
  133. Handle            h;
  134. Ptr                p;
  135.  
  136.  
  137. ConnHandle        prefConn;
  138.  
  139. ConnHandle        docConn;
  140. CMBufferSizes    sizes    = { 0, 0, 0, 0, 0, 0, 0, 0 };
  141.  
  142.  
  143.  
  144.     infoPB        = (CInfoPBPtr)NewPtrClear(sizeof(*infoPB));
  145.     wdPB        = (WDPBPtr)NewPtrClear(sizeof(*wdPB));
  146.     dirPB        = (HParmBlkPtr)NewPtrClear(sizeof(*dirPB));
  147.  
  148.  
  149.     /* find the system folder's volume reference number and directory ID */
  150.     osErr = SysEnvirons(curSysEnvVers, &theWorld);
  151.     (*wdPB).ioVRefNum = theWorld.sysVRefNum;
  152.  
  153.     if (noErr == (osErr = PBGetWDInfo(wdPB, false)))
  154.     {
  155.         /*********************************************************
  156.         * 11-27-91 Modified by Mark Sproul
  157.         **********************************************************/
  158.         /* get the Volume Reference Number and save it */
  159.         prefVRefNum    = (*wdPB).ioWDVRefNum;
  160.         /* get the System directir ID and save it */
  161.         sysfDirID    = (*wdPB).ioWDDirID;
  162.         
  163.         /* check for the preferences folder */
  164.         (*infoPB).hFileInfo.ioFDirIndex    = 0;
  165.         (*infoPB).hFileInfo.ioVRefNum    = prefVRefNum;
  166.         (*infoPB).hFileInfo.ioDirID        = sysfDirID;
  167.         (*infoPB).hFileInfo.ioNamePtr    = "\pPreferences";
  168.         osErr = PBGetCatInfo(infoPB, false);
  169.         /* save the "Preferecnces" dir number */ 
  170.         prefDirID    = (*infoPB).hFileInfo.ioDirID;
  171.         
  172.         if (osErr == fnfErr)
  173.         {
  174.             /* Create "Preferences" folder */
  175.             (*dirPB).fileParam.ioVRefNum    = prefVRefNum;
  176.             (*dirPB).fileParam.ioDirID        = sysfDirID;
  177.             (*dirPB).fileParam.ioNamePtr    = "\pPreferences";
  178.             osErr = PBDirCreate(dirPB, false);
  179.             prefDirID    = (*dirPB).fileParam.ioDirID;
  180.         }
  181.  
  182.         /*********************************************************
  183.         * end of modifications
  184.         **********************************************************/
  185.         if (osErr == noErr)
  186.         {
  187.             /* does the preference file exist? */
  188.             (*infoPB).hFileInfo.ioFDirIndex    = 0;
  189.             (*infoPB).hFileInfo.ioVRefNum    = prefVRefNum;
  190.             (*infoPB).hFileInfo.ioDirID        = prefDirID;
  191.             (*infoPB).hFileInfo.ioNamePtr    = prefsFileName;
  192.             osErr = PBGetCatInfo(infoPB, false);
  193.             if (osErr == noErr)
  194.             {
  195.                 /* set flag saying the prefs file is OK */
  196.                 prefFileOKFlag = 0xAA;
  197.             }
  198.             if (osErr == fnfErr)
  199.             {
  200.                 /* no, so create a new preference file */
  201.                 if (noErr == (osErr = HCreate(prefVRefNum, prefDirID, prefsFileName, creatorType, fileType)))
  202.                 {
  203.                     HCreateResFile(prefVRefNum, prefDirID, prefsFileName);
  204.                     if (noErr == (osErr = ResError()))
  205.                     {
  206.                         /* open the preference file */
  207.                         prefRefNum = HOpenResFile(prefVRefNum, prefDirID, prefsFileName, fsRdWrPerm);
  208.                         if (prefRefNum == -1)
  209.                         {
  210.                             osErr = ResError();
  211.                         }
  212.                         else
  213.                         {
  214.                             /* create a default connection */
  215.                             osErr = CRMGetIndToolName(classCM, 1,toolName);
  216.                             if (noErr == osErr)
  217.                             {
  218.                                 prefConn = CMNew(CMGetProcID(toolName), cmData, sizes, 0, 0);
  219.                                 /* leave the default setting as the preferance */
  220.                                 
  221.                                 /************************************************************
  222.                                 * ORIGINALLY, the code let the user select setup at this point
  223.                                 * I do not want it asking for serial port prefs on startup
  224.                                 * if they are not set.
  225.                                 * ---allow the user to select a prefered tool and configuration
  226.                                 * ---osErr = CMChoose(&prefConn, where, nil);
  227.                                 ************************************************************/
  228.                             
  229.                                 /* write the prefered tool name to the preference file */
  230.                                 HLock((Handle) prefConn);
  231.                                 CMGetToolName((**prefConn).procID, toolName);
  232.                                 HUnlock((Handle) prefConn);
  233.                                 h = NewHandle(1 + toolName[0]);
  234.                                 HLock(h);
  235.                                 BlockMove(toolName, *h, GetHandleSize(h));
  236.                                 HUnlock(h);
  237.                                 AddResource(h, 'pTXT', 0, "");
  238.                                 ReleaseResource(h);
  239.                                 /* write the prefered configuration to the preference file */
  240.                                 p = CMGetConfig(prefConn);
  241.                                 h = NewHandle(GetPtrSize(p));
  242.                                 HLock(h);
  243.                                 BlockMove(p, *h, GetHandleSize(h));
  244.                                 HUnlock(h);
  245.                                 AddResource(h, 'cTXT', 0, "");
  246.                                 ReleaseResource(h);
  247.                                 DisposPtr(p);
  248.                                 
  249.                                 /* dispose of the connection */
  250.                                 CMDispose(prefConn);
  251.                             }
  252.                             /* close the file so that it can be used in a shared environment */
  253.                             CloseResFile(prefRefNum);
  254.                             /* set flag saying the prefs file is OK */
  255.                             prefFileOKFlag = 0xAA;
  256.                         }
  257.                     }
  258.                 }
  259.             }
  260.         }
  261.     }
  262. }
  263.  
  264. //*****************************************************************
  265. //*
  266. //* The following code was written by Mark Sproul
  267. //* This code allows easy access to prefs file
  268. //*
  269. //*
  270. //*
  271. //*
  272. //*****************************************************************
  273.  
  274. /**************************************
  275. * get resource from Prefs file
  276. *
  277. ****************************************/
  278. getPrefsResourceStr(prefsFileName, perfsResType, returnString)
  279. Str255        prefsFileName;
  280. OSType        perfsResType;
  281. Str255        returnString;
  282. {
  283. short            prefRefNum;
  284. Handle            h;
  285. int                i;
  286. Size            hSize;
  287.  
  288.     h = nil;
  289.     /* did the prefs file get opened or created OK */
  290.     if (prefFileOKFlag == 0xAA)
  291.     {
  292.         /* focus on the preference file */
  293.         prefRefNum = HOpenResFile(prefVRefNum, prefDirID, prefsFileName, fsRdWrPerm);
  294.         if (prefRefNum != -1)
  295.         {
  296.             h = Get1Resource(perfsResType, 0);
  297.             hSize = GetHandleSize(h);            /* get the size of the handle */
  298.             if (hSize > 255) hSize = 255;
  299.             HLock(h);
  300.             /* had to have this to make it compile under THINK C 5.0 */
  301.             for (i=0; i< hSize; i++)
  302.             {
  303.                 returnString[i] = *(*h+i);
  304.             }
  305.             HUnlock(h);
  306.             ReleaseResource(h);
  307.             CloseResFile(prefRefNum);
  308.         }
  309.     }
  310. }
  311.  
  312.  
  313. /**************************************
  314. * set Comm Tool Box connection preference
  315. *
  316. ****************************************/
  317. setCTBpref(prefsFileName)
  318. Str255        prefsFileName;
  319. {
  320. short            prefRefNum;
  321. OSErr            osErr, cmChooseReturnCode;
  322. int                i;
  323. Str255            prefStr;
  324. short            procID;
  325. Str63            toolName;
  326. Handle            h;
  327. Ptr                p;
  328. short            iErr;
  329. Size            hSize, newSize;
  330.  
  331. ConnHandle        docConn;
  332. CMBufferSizes    sizes    = { 0, 0, 0, 0, 0, 0, 0, 0 };
  333. Point            where    = { 75, 75 };
  334.  
  335.     if (isCTBavailable())
  336.     {
  337.         /* did the prefs file get opened or created OK */
  338.         if (prefFileOKFlag == 0xAA)
  339.         {
  340.             getPrefsResourceStr(prefsFileName,'pTXT', prefStr);
  341.     
  342.             procID = CMGetProcID(prefStr);
  343.             if (procID != -1)
  344.             {
  345.                 /* create a new connection */
  346.                 docConn    = CMNew(procID, cmData, sizes, 0, 0);
  347.                 
  348.                 if (docConn != nil)
  349.                 {
  350.                     /* set the prefered configuration */
  351.         
  352.                     getPrefsResourceStr(prefsFileName,'cTXT', prefStr);
  353.                     osErr    = CMSetConfig(docConn, (char *)prefStr);
  354.     
  355.                     cmChooseReturnCode    = CMChoose(&docConn, where, nil);
  356.                 }
  357.             }
  358.             else
  359.             {
  360.                 /* the prefered tool could not be found so I */
  361.                 osErr    = CRMGetIndToolName(classCM, 1, toolName);
  362.                 docConn    = CMNew(CMGetProcID(toolName), cmData, sizes, 0, 0);
  363.                 if (docConn != nil)
  364.                 {
  365.                     cmChooseReturnCode    = CMChoose(&docConn, where, nil);
  366.                 }
  367.             }
  368.             
  369.             if ((cmChooseReturnCode == chooseOKMinor) || (cmChooseReturnCode == chooseOKMajor))
  370.             {
  371.                 /* change the prefs file */
  372.                 
  373.                 if (prefFileOKFlag == 0xAA)
  374.                 {
  375.                     /* open the preference file */
  376.                     prefRefNum = HOpenResFile(prefVRefNum, prefDirID, prefsFileName, fsRdWrPerm);
  377.                     if (prefRefNum != -1)
  378.                     {
  379.                         /* write the prefered tool name to the preference file */
  380.                         HLock((Handle) docConn);
  381.                         CMGetToolName((**docConn).procID, toolName);
  382.                         HUnlock((Handle) docConn);
  383.                         
  384.                         /* get the port TeXT resource */
  385.                         h = Get1Resource('pTXT', 0);
  386.                         if (h == nil)
  387.                         {
  388.                             /* resource did not exist, add it to resource file */
  389.                             h = NewHandle(1 + toolName[0]);
  390.                             HLock(h);
  391.                             BlockMove(toolName, *h, GetHandleSize(h));
  392.                             HUnlock(h);
  393.                             AddResource(h, 'pTXT', 0, "");
  394.                         }
  395.                         else
  396.                         {
  397.                             /* resoure DOES exist, change it */
  398.                             hSize = GetHandleSize(h);            /* get the size of the handle */
  399.                             /* check for size of handle */
  400.                             if (hSize != (1 + toolName[0]))
  401.                             {
  402.                                 newSize = 1 + toolName[0];
  403.                                 SetHandleSize(h, newSize);
  404.                             }
  405.                             HLock(h);
  406.                             BlockMove(toolName, *h, GetHandleSize(h));
  407.                             HUnlock(h);
  408.                             ChangedResource(h);
  409.                         }
  410.                         ReleaseResource(h);
  411.                         
  412.                         /* write the prefered configuration to the preference file */
  413.                         p = CMGetConfig(docConn);
  414.     
  415.     
  416.                         /* get the configuration TeXT resource */
  417.                         h = Get1Resource('cTXT', 0);
  418.                         if (h == nil)
  419.                         {
  420.                             /* resource did not exist, add it to resource file */
  421.                             h = NewHandle(GetPtrSize(p));
  422.                             HLock(h);
  423.                             BlockMove(p, *h, GetHandleSize(h));
  424.                             HUnlock(h);
  425.                         
  426.                             AddResource(h, 'cTXT', 0, "");
  427.                             iErr = ResError();
  428.                         }
  429.                         else
  430.                         {
  431.                             /* resoure DOES exist, change it */
  432.                             hSize = GetHandleSize(h);            /* get the size of the handle */
  433.                             /* check for size of handle */
  434.                             if (hSize != GetPtrSize(p))
  435.                             {
  436.                                 newSize = GetPtrSize(p);
  437.                                 SetHandleSize(h, newSize);
  438.                             }
  439.                             HLock(h);
  440.                             BlockMove(p, *h, GetHandleSize(h));
  441.                             HUnlock(h);
  442.                             ChangedResource(h);
  443.                         }
  444.                         ReleaseResource(h);
  445.     
  446.                         CloseResFile(prefRefNum);
  447.                         iErr = ResError();
  448.                         DisposPtr(p);
  449.                     }
  450.                 }
  451.             }
  452.             
  453.             if (docConn != nil)
  454.             {
  455.                 /* dispose of the connection */
  456.                 CMDispose(docConn);
  457.             }
  458.     
  459.         }
  460.     }
  461. }
  462.  
  463.  
  464. DoCommPortSetup(prefsFileName)
  465. Str255    prefsFileName;
  466. {
  467.     setCTBpref(prefsFileName);
  468.  
  469. }
  470.  
  471. - -------------------------------------
  472. Mark Sproul - KB2ICI
  473.  
  474. +++++++++++++++++++++++++++
  475.  
  476. From: grobbins@Apple.COM (Grobbins)
  477. Date: 29 Sep 92 23:58:55 GMT
  478. Organization: Apple Computer Inc., Cupertino, CA
  479.  
  480. In article <D2150096.o1pwue@sproul.sproul.com> Sproul@sproul.sproul.com (Mark Sproul) writes:
  481. >Several people asked for this source code. ...It now handles the PREFERENCES
  482. >folder in the system folder properly.
  483.  
  484. No, it hardcodes the name "Preferences" and assumes that it is in the
  485. System folder.  Applications should instead use FindFolder under
  486. Systems 6 or 7 to locate the preferences folder.  FindFolder is
  487. documented starting on page 9-42 of Inside Mac VI.
  488.  
  489. Pasted below is the Q&A from issue 11 of develop magazine on
  490. preference files.
  491.  
  492. Grobbins         grobbins@apple.com
  493.  
  494. Usual disclaimers apply.
  495.  
  496. - -------------------------------------------------------
  497.  
  498. I want to place my user's preference file into the
  499. Preferences folder in the System folder under System 7, but I
  500. can't seem to get that folder's DirID and other information
  501. so my file will appear there! Additionally, how do I get to
  502. that folder if the user changes the names of the System
  503. Folder and Preferences folder? Also, once it's there, am I
  504. assuming correctly that the best way to find it again is to
  505. make an alias record to track the file ID?
  506. ___
  507.  
  508. System 7 introduced the routine FindFolder for locating the
  509. Preferences folder. Just make this call
  510.  
  511.    err := FindFolder(kOnSystemDisk, kPreferencesFolderType,
  512.             kCreateFolder, prefVRefNum, prefDirID);
  513.  
  514. and, if err is noErr, then prefVRefNum and prefDirID will
  515. contain the vRefNum and dirID of the Preferences folder. This
  516. can be used with HCreateResFile, HOpenResFile, PBHGetFInfo,
  517. or other File Manager calls to get to your preferences file.
  518. If a Preferences folder does not already exist, the
  519. kCreateFolder parameter instructs FindFolder to make one and
  520. return the vRefNum and dirID of the new folder as prefVRefNum
  521. and prefDirID.
  522.  
  523. FindFolder is documented in Chapter 9 of Inside Macintosh
  524. Volume VI, under "The System Folder and its Related
  525. Directories." While the FindFolder trap is only implemented
  526. under System 7 (check the gestalt selector
  527. gestaltFindFolderAttr, documented in Chapter 3 of Inside
  528. Macintosh VI, to see if FindFolder is available), if you're
  529. using MPW 3.2 (or the current Think compilers) glue is
  530. automatically included in your compiled code, making it safe
  531. to call FindFolder under System 6. The glue will check if
  532. FindFolder is available, and if it is not, will return the
  533. System folder's vRefNum and dirID as as prefVRefNum and
  534. prefDirID for the kPreferencesFolderType selector. Go ahead
  535. and use the System folder values as the location for the
  536. preferences file under System 6.
  537.  
  538. If you're not using a development system that provides the
  539. FindFolder glue, your code should check the FindFolder
  540. gestalt attribute to see if FindFolder is available. If
  541. FindFolder is available, call it. FindFolder is defined as
  542.  
  543.     FUNCTION FindFolder(vRefNum: INTEGER;folderType: OSType;
  544.                         createFolder: BOOLEAN;
  545.         VAR foundVRefNum: INTEGER;VAR foundDirID: LONGINT):OSErr;
  546.         INLINE $7000,$A823;
  547.  
  548. If FindFolder is not available, call SysEnvirons to find the
  549. System folder's WDRefNum, call PBGetWDInfo or GetWDInfo to
  550. convert the WDRefNum to a true vRefNum and dirID, and use
  551. those System folder numbers for the location of the
  552. preferences file. Example code for this is in the Q&A Stack,
  553. under Operating System:File System:Code for identifying
  554. vRefNum and dirID of Macintosh System Folder.
  555.  
  556. To locate the Preferences folder, use the above procedure
  557. rather than try to keep an alias of the Preferences folder or
  558. of the preferences file. However, if there are any other
  559. files in the System Folder upon which the application depends
  560. (such as dictionaries) those should be tracked with aliases,
  561. stored as 'alis' resources in the preferences file. See
  562. Chapter 27 of Inside Macintosh Volume VI for information on
  563. using aliases.
  564.  
  565. +++++++++++++++++++++++++++
  566.  
  567. From: peter@cujo.curtin.edu.au (Peter N Lewis)
  568. Organization: NCRPDA, Curtin University
  569. Date: Thu, 1 Oct 1992 02:27:00 GMT
  570.  
  571. In article <72915@apple.Apple.COM>, grobbins@Apple.COM (Grobbins) wrote:
  572. > 
  573. > In article <D2150096.o1pwue@sproul.sproul.com> Sproul@sproul.sproul.com (Mark Sproul) writes:
  574. > >Several people asked for this source code. ...It now handles the PREFERENCES
  575. > >folder in the system folder properly.
  576. > 
  577. > No, it hardcodes the name "Preferences" and assumes that it is in the
  578. > System folder.  Applications should instead use FindFolder under
  579. > Systems 6 or 7 to locate the preferences folder.  FindFolder is
  580. > documented starting on page 9-42 of Inside Mac VI.
  581.  
  582. Q&A:
  583. > gestaltFindFolderAttr, documented in Chapter 3 of Inside
  584. > Macintosh VI, to see if FindFolder is available), if you're
  585. > using MPW 3.2 (or the current Think compilers) glue is
  586. > automatically included in your compiled code, making it safe
  587. > to call FindFolder under System 6. The glue will check if
  588. > FindFolder is available, and if it is not, will return the
  589. > System folder's vRefNum and dirID as as prefVRefNum and
  590. > prefDirID for the kPreferencesFolderType selector. Go ahead
  591. > and use the System folder values as the location for the
  592. > preferences file under System 6.
  593.  
  594. While I agree you should use FindFolder (definitely don't hard code it!),
  595. and its really nice that you can just call it without worrying about
  596. whether its implemented or not, I disagree with using the System Folder on
  597. System 6 machines.  Many programs (mostly sharware programs I think :-)
  598. were using the Preferences folder before System 7 was even released.  Its
  599. sad that its always the english spelling, but we can't do much about that
  600. except put it in the resource fork so it can be internationalized, but the
  601. Preferences folder is at least a good approximation.
  602.  
  603. So I'd say (blatantly ignoring Apple's recomendation, and waiting for the
  604. Apple Thought Police to come break down my door :), check if you are
  605. running in System 6, and create and use the Preferences folder if you are
  606. (you can (of course) use FindFolder to find the System Folder so you know
  607. where to look for/put the Preferences folder...)
  608.  
  609. Have fun all, I'll go lock my door :-)
  610.    Peter.
  611.  
  612. _______________________________________________________________________
  613. Peter N Lewis, NCRPDA, Curtin University       peter@cujo.curtin.edu.au
  614. GPO Box U1987, Perth WA 6001, AUSTRALIA             FAX: +61 9 367 8141
  615.  
  616. +++++++++++++++++++++++++++
  617.  
  618. From: Sproul@sproul.sproul.com (Mark Sproul)
  619. Date: 2 Oct 92 09:05:30 GMT
  620. Organization: Sproul Consulting
  621.  
  622.  
  623. Several people asked for this source code.  As explained in the comments,
  624. it came from Inside Mac Comm Toolbox and there is a lot of code dealing
  625. just with the Comm Tool box setup.  It now handles the PREFERENCES
  626. folder in the system folder properly.
  627.  
  628. I have done some additions to the code to make it more general and
  629. usable as far as dealing with preferences.  Such as GET pref and SET
  630. pref.  This code was all written and runs correctly with Think C 5.0.
  631.  
  632. Its been several months since I wrote this and was looking at it.
  633. I may have forgotten to mention something, if you have any problems
  634. let me know and I will post updates.
  635.  
  636. You need to define some things such as this:
  637.  
  638. #define    creatorType        'abcd'
  639. #define    fileType        'PREF'
  640. #define    prefsFileName    "\pMyPreferences"
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647. /******************************************************************************
  648. * adapted from
  649. *  Inside the Macintosh Communications Toolbox
  650. * Page  333
  651. * After initialization, the code shown first checks if a
  652. * preferences folder, which contains tool settings written in preference
  653. * files, already exists. If so, the application uses the settings in this file.
  654. * Otherwise, the code generates a new preferences file.
  655. ******************************************************************************
  656. * Modifications
  657. ******************************************************************************
  658. * Nov 27, 1991    Original version had a bug in it.
  659. *                If the "Preferences" directory already existed, the preferences file
  660. *                was placed in the system folder, not in the "Preferences" directory.
  661. *                If the directory did NOT exist, everything worked fine.
  662. *                I also changed it to check for the existance of the "Preferences" folder
  663. *                first instead of trying to create one and letting an duplicate file error
  664. *                indicate that it already existed.
  665. *                by Mark Sproul
  666. *                Internet: sproul@sproul.com
  667. *                AppleLink: Sproul.M
  668. * Jan 16, 1992    Working on a general purpose prefs file manipulator
  669. * Jan 25, 1992    Prefs file resources working great
  670. ******************************************************************************/
  671.  
  672. #include    <Connections.h>
  673. #include    <CommResources.h>
  674.  
  675. /*
  676. ** Global Variables used by all of the prefs routines
  677. */
  678. long            prefDirID;            /* Prefs Dir ID number */
  679. long            sysfDirID;            /* System folder Dir ID number */
  680. short            prefVRefNum;        /* Prefs Volume Ref number */
  681. short            prefFileOKFlag = 0;    /* prefs file OK indicator */
  682.  
  683. /*************************************************************
  684. * This makes sure there is a prefs file in the PREFERENCES directory
  685. * if not, it creates it.
  686. *
  687. * getPrefsFile MUST be called before any atempt at getting the prefs values
  688. *
  689. *************************************************************/
  690.  
  691. void getPrefsFile(prefsFileName, creatorType, fileType)
  692. Str255        prefsFileName;
  693. OSType        creatorType;
  694. OSType        fileType;
  695. {
  696. OSErr            osErr        = noErr;
  697. SysEnvRec        theWorld;
  698. CInfoPBPtr        infoPB;
  699. WDPBPtr            wdPB;
  700. HParmBlkPtr        dirPB;
  701.  
  702. short            prefRefNum;
  703. Point            where    = { 75, 75 };
  704. Str63            toolName;
  705. short            procID;
  706. Handle            h;
  707. Ptr                p;
  708.  
  709.  
  710. ConnHandle        prefConn;
  711.  
  712. ConnHandle        docConn;
  713. CMBufferSizes    sizes    = { 0, 0, 0, 0, 0, 0, 0, 0 };
  714.  
  715.  
  716.  
  717.     infoPB        = (CInfoPBPtr)NewPtrClear(sizeof(*infoPB));
  718.     wdPB        = (WDPBPtr)NewPtrClear(sizeof(*wdPB));
  719.     dirPB        = (HParmBlkPtr)NewPtrClear(sizeof(*dirPB));
  720.  
  721.  
  722.     /* find the system folder's volume reference number and directory ID */
  723.     osErr = SysEnvirons(curSysEnvVers, &theWorld);
  724.     (*wdPB).ioVRefNum = theWorld.sysVRefNum;
  725.  
  726.     if (noErr == (osErr = PBGetWDInfo(wdPB, false)))
  727.     {
  728.         /*********************************************************
  729.         * 11-27-91 Modified by Mark Sproul
  730.         **********************************************************/
  731.         /* get the Volume Reference Number and save it */
  732.         prefVRefNum    = (*wdPB).ioWDVRefNum;
  733.         /* get the System directir ID and save it */
  734.         sysfDirID    = (*wdPB).ioWDDirID;
  735.         
  736.         /* check for the preferences folder */
  737.         (*infoPB).hFileInfo.ioFDirIndex    = 0;
  738.         (*infoPB).hFileInfo.ioVRefNum    = prefVRefNum;
  739.         (*infoPB).hFileInfo.ioDirID        = sysfDirID;
  740.         (*infoPB).hFileInfo.ioNamePtr    = "\pPreferences";
  741.         osErr = PBGetCatInfo(infoPB, false);
  742.         /* save the "Preferecnces" dir number */ 
  743.         prefDirID    = (*infoPB).hFileInfo.ioDirID;
  744.         
  745.         if (osErr == fnfErr)
  746.         {
  747.             /* Create "Preferences" folder */
  748.             (*dirPB).fileParam.ioVRefNum    = prefVRefNum;
  749.             (*dirPB).fileParam.ioDirID        = sysfDirID;
  750.             (*dirPB).fileParam.ioNamePtr    = "\pPreferences";
  751.             osErr = PBDirCreate(dirPB, false);
  752.             prefDirID    = (*dirPB).fileParam.ioDirID;
  753.         }
  754.  
  755.         /*********************************************************
  756.         * end of modifications
  757.         **********************************************************/
  758.         if (osErr == noErr)
  759.         {
  760.             /* does the preference file exist? */
  761.             (*infoPB).hFileInfo.ioFDirIndex    = 0;
  762.             (*infoPB).hFileInfo.ioVRefNum    = prefVRefNum;
  763.             (*infoPB).hFileInfo.ioDirID        = prefDirID;
  764.             (*infoPB).hFileInfo.ioNamePtr    = prefsFileName;
  765.             osErr = PBGetCatInfo(infoPB, false);
  766.             if (osErr == noErr)
  767.             {
  768.                 /* set flag saying the prefs file is OK */
  769.                 prefFileOKFlag = 0xAA;
  770.             }
  771.             if (osErr == fnfErr)
  772.             {
  773.                 /* no, so create a new preference file */
  774.                 if (noErr == (osErr = HCreate(prefVRefNum, prefDirID, prefsFileName, creatorType, fileType)))
  775.                 {
  776.                     HCreateResFile(prefVRefNum, prefDirID, prefsFileName);
  777.                     if (noErr == (osErr = ResError()))
  778.                     {
  779.                         /* open the preference file */
  780.                         prefRefNum = HOpenResFile(prefVRefNum, prefDirID, prefsFileName, fsRdWrPerm);
  781.                         if (prefRefNum == -1)
  782.                         {
  783.                             osErr = ResError();
  784.                         }
  785.                         else
  786.                         {
  787.                             /* create a default connection */
  788.                             osErr = CRMGetIndToolName(classCM, 1,toolName);
  789.                             if (noErr == osErr)
  790.                             {
  791.                                 prefConn = CMNew(CMGetProcID(toolName), cmData, sizes, 0, 0);
  792.                                 /* leave the default setting as the preferance */
  793.                                 
  794.                                 /************************************************************
  795.                                 * ORIGINALLY, the code let the user select setup at this point
  796.                                 * I do not want it asking for serial port prefs on startup
  797.                                 * if they are not set.
  798.                                 * ---allow the user to select a prefered tool and configuration
  799.                                 * ---osErr = CMChoose(&prefConn, where, nil);
  800.                                 ************************************************************/
  801.                             
  802.                                 /* write the prefered tool name to the preference file */
  803.                                 HLock((Handle) prefConn);
  804.                                 CMGetToolName((**prefConn).procID, toolName);
  805.                                 HUnlock((Handle) prefConn);
  806.                                 h = NewHandle(1 + toolName[0]);
  807.                                 HLock(h);
  808.                                 BlockMove(toolName, *h, GetHandleSize(h));
  809.                                 HUnlock(h);
  810.                                 AddResource(h, 'pTXT', 0, "");
  811.                                 ReleaseResource(h);
  812.                                 /* write the prefered configuration to the preference file */
  813.                                 p = CMGetConfig(prefConn);
  814.                                 h = NewHandle(GetPtrSize(p));
  815.                                 HLock(h);
  816.                                 BlockMove(p, *h, GetHandleSize(h));
  817.                                 HUnlock(h);
  818.                                 AddResource(h, 'cTXT', 0, "");
  819.                                 ReleaseResource(h);
  820.                                 DisposPtr(p);
  821.                                 
  822.                                 /* dispose of the connection */
  823.                                 CMDispose(prefConn);
  824.                             }
  825.                             /* close the file so that it can be used in a shared environment */
  826.                             CloseResFile(prefRefNum);
  827.                             /* set flag saying the prefs file is OK */
  828.                             prefFileOKFlag = 0xAA;
  829.                         }
  830.                     }
  831.                 }
  832.             }
  833.         }
  834.     }
  835. }
  836.  
  837. //*****************************************************************
  838. //*
  839. //* The following code was written by Mark Sproul
  840. //* This code allows easy access to prefs file
  841. //*
  842. //*
  843. //*
  844. //*
  845. //*****************************************************************
  846.  
  847. /**************************************
  848. * get resource from Prefs file
  849. *
  850. ****************************************/
  851. getPrefsResourceStr(prefsFileName, perfsResType, returnString)
  852. Str255        prefsFileName;
  853. OSType        perfsResType;
  854. Str255        returnString;
  855. {
  856. short            prefRefNum;
  857. Handle            h;
  858. int                i;
  859. Size            hSize;
  860.  
  861.     h = nil;
  862.     /* did the prefs file get opened or created OK */
  863.     if (prefFileOKFlag == 0xAA)
  864.     {
  865.         /* focus on the preference file */
  866.         prefRefNum = HOpenResFile(prefVRefNum, prefDirID, prefsFileName, fsRdWrPerm);
  867.         if (prefRefNum != -1)
  868.         {
  869.             h = Get1Resource(perfsResType, 0);
  870.             hSize = GetHandleSize(h);            /* get the size of the handle */
  871.             if (hSize > 255) hSize = 255;
  872.             HLock(h);
  873.             /* had to have this to make it compile under THINK C 5.0 */
  874.             for (i=0; i< hSize; i++)
  875.             {
  876.                 returnString[i] = *(*h+i);
  877.             }
  878.             HUnlock(h);
  879.             ReleaseResource(h);
  880.             CloseResFile(prefRefNum);
  881.         }
  882.     }
  883. }
  884.  
  885.  
  886. /**************************************
  887. * set Comm Tool Box connection preference
  888. *
  889. ****************************************/
  890. setCTBpref(prefsFileName)
  891. Str255        prefsFileName;
  892. {
  893. short            prefRefNum;
  894. OSErr            osErr, cmChooseReturnCode;
  895. int                i;
  896. Str255            prefStr;
  897. short            procID;
  898. Str63            toolName;
  899. Handle            h;
  900. Ptr                p;
  901. short            iErr;
  902. Size            hSize, newSize;
  903.  
  904. ConnHandle        docConn;
  905. CMBufferSizes    sizes    = { 0, 0, 0, 0, 0, 0, 0, 0 };
  906. Point            where    = { 75, 75 };
  907.  
  908.     if (isCTBavailable())
  909.     {
  910.         /* did the prefs file get opened or created OK */
  911.         if (prefFileOKFlag == 0xAA)
  912.         {
  913.             getPrefsResourceStr(prefsFileName,'pTXT', prefStr);
  914.     
  915.             procID = CMGetProcID(prefStr);
  916.             if (procID != -1)
  917.             {
  918.                 /* create a new connection */
  919.                 docConn    = CMNew(procID, cmData, sizes, 0, 0);
  920.                 
  921.                 if (docConn != nil)
  922.                 {
  923.                     /* set the prefered configuration */
  924.         
  925.                     getPrefsResourceStr(prefsFileName,'cTXT', prefStr);
  926.                     osErr    = CMSetConfig(docConn, (char *)prefStr);
  927.     
  928.                     cmChooseReturnCode    = CMChoose(&docConn, where, nil);
  929.                 }
  930.             }
  931.             else
  932.             {
  933.                 /* the prefered tool could not be found so I */
  934.                 osErr    = CRMGetIndToolName(classCM, 1, toolName);
  935.                 docConn    = CMNew(CMGetProcID(toolName), cmData, sizes, 0, 0);
  936.                 if (docConn != nil)
  937.                 {
  938.                     cmChooseReturnCode    = CMChoose(&docConn, where, nil);
  939.                 }
  940.             }
  941.             
  942.             if ((cmChooseReturnCode == chooseOKMinor) || (cmChooseReturnCode == chooseOKMajor))
  943.             {
  944.                 /* change the prefs file */
  945.                 
  946.                 if (prefFileOKFlag == 0xAA)
  947.                 {
  948.                     /* open the preference file */
  949.                     prefRefNum = HOpenResFile(prefVRefNum, prefDirID, prefsFileName, fsRdWrPerm);
  950.                     if (prefRefNum != -1)
  951.                     {
  952.                         /* write the prefered tool name to the preference file */
  953.                         HLock((Handle) docConn);
  954.                         CMGetToolName((**docConn).procID, toolName);
  955.                         HUnlock((Handle) docConn);
  956.                         
  957.                         /* get the port TeXT resource */
  958.                         h = Get1Resource('pTXT', 0);
  959.                         if (h == nil)
  960.                         {
  961.                             /* resource did not exist, add it to resource file */
  962.                             h = NewHandle(1 + toolName[0]);
  963.                             HLock(h);
  964.                             BlockMove(toolName, *h, GetHandleSize(h));
  965.                             HUnlock(h);
  966.                             AddResource(h, 'pTXT', 0, "");
  967.                         }
  968.                         else
  969.                         {
  970.                             /* resoure DOES exist, change it */
  971.                             hSize = GetHandleSize(h);            /* get the size of the handle */
  972.                             /* check for size of handle */
  973.                             if (hSize != (1 + toolName[0]))
  974.                             {
  975.                                 newSize = 1 + toolName[0];
  976.                                 SetHandleSize(h, newSize);
  977.                             }
  978.                             HLock(h);
  979.                             BlockMove(toolName, *h, GetHandleSize(h));
  980.                             HUnlock(h);
  981.                             ChangedResource(h);
  982.                         }
  983.                         ReleaseResource(h);
  984.                         
  985.                         /* write the prefered configuration to the preference file */
  986.                         p = CMGetConfig(docConn);
  987.     
  988.     
  989.                         /* get the configuration TeXT resource */
  990.                         h = Get1Resource('cTXT', 0);
  991.                         if (h == nil)
  992.                         {
  993.                             /* resource did not exist, add it to resource file */
  994.                             h = NewHandle(GetPtrSize(p));
  995.                             HLock(h);
  996.                             BlockMove(p, *h, GetHandleSize(h));
  997.                             HUnlock(h);
  998.                         
  999.                             AddResource(h, 'cTXT', 0, "");
  1000.                             iErr = ResError();
  1001.                         }
  1002.                         else
  1003.                         {
  1004.                             /* resoure DOES exist, change it */
  1005.                             hSize = GetHandleSize(h);            /* get the size of the handle */
  1006.                             /* check for size of handle */
  1007.                             if (hSize != GetPtrSize(p))
  1008.                             {
  1009.                                 newSize = GetPtrSize(p);
  1010.                                 SetHandleSize(h, newSize);
  1011.                             }
  1012.                             HLock(h);
  1013.                             BlockMove(p, *h, GetHandleSize(h));
  1014.                             HUnlock(h);
  1015.                             ChangedResource(h);
  1016.                         }
  1017.                         ReleaseResource(h);
  1018.     
  1019.                         CloseResFile(prefRefNum);
  1020.                         iErr = ResError();
  1021.                         DisposPtr(p);
  1022.                     }
  1023.                 }
  1024.             }
  1025.             
  1026.             if (docConn != nil)
  1027.             {
  1028.                 /* dispose of the connection */
  1029.                 CMDispose(docConn);
  1030.             }
  1031.     
  1032.         }
  1033.     }
  1034. }
  1035.  
  1036.  
  1037. DoCommPortSetup(prefsFileName)
  1038. Str255    prefsFileName;
  1039. {
  1040.     setCTBpref(prefsFileName);
  1041.  
  1042. }
  1043.  
  1044.  
  1045. - -------------------------------------
  1046. Mark Sproul - KB2ICI
  1047.  
  1048. +++++++++++++++++++++++++++
  1049.  
  1050. From: winer@husc8.harvard.edu (Adam Winer)
  1051. Date: 2 Oct 92 20:12:00 GMT
  1052. Organization: Harvard University Science Center
  1053.  
  1054. If I remember correctly, there is MPW (and hence THINK C) glue that, if
  1055. FindFolder is called in a system without it, will just return the location
  1056. of the System Folder.  Sounds pretty good to me, if it works.
  1057.  
  1058. Adam
  1059. - -- 
  1060. Adam Winer        | The number you have reached is imaginary.
  1061. WINER@HARVARD.EDU    | Please rotate your phone 90 degrees and
  1062.                         | try again.
  1063.  
  1064. ---------------------------
  1065.  
  1066. End of C.S.M.P. Digest
  1067. **********************
  1068.